Skip to main content

Cancel a payment intent

DELETE 
/baskets/:id/payment-intents/:paymentIntentId

Cancels the previously created payment intent. A payment intent can only be cancelled if payment has not already been completed. If you cancel the payment intent whilst a payment is processing with the payment provider, the payment will be rejected when it arrives to OneBasket from the provider.

Request​

Path Parameters

    id stringrequired

    The id of the basket

    paymentIntentId stringrequired

    The id of the payment intent to delete.

Header Parameters

    x-api-key stringrequired

    The API key for the given store

Responses​

Cancelling a payment intent is an asynchronous operation. Once complete there will be no content result in the notification payload.

Schema
    notificationId stringrequired

    The id of a notification that represents this asynchronous request. OneBasket will be processing the request in the background, and upon completion this notification will be updated with the result.

Loading...